<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>include/shark/Algorithms/GradientDescent/LineSearch.h Source File</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d0c4981f10d03078bcfd5c74fe41ce8.html">shark</a></li><li class="navelem"><a class="el" href="dir_24fc231769ada4cfc8add7cd238ad0f8.html">Algorithms</a></li><li class="navelem"><a class="el" href="dir_8cf7bbd6cc4a03fc07b4c23fb0ac6fa7.html">GradientDescent</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">LineSearch.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_line_search_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">//===========================================================================</span><span class="comment"></span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">/*!</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * </span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * \brief       LineSearch</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * </span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * </span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> * \author      O. Krause, S. Dahlgaard</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> * \date        2010-2017</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> *</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * \par Copyright 1995-2017 Shark Development Team</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * </span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * &lt;BR&gt;&lt;HR&gt;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * This file is part of Shark.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> * &lt;https://shark-ml.github.io/Shark/&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> * </span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"> * Shark is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment"> * it under the terms of the GNU Lesser General Public License as published </span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment"> * by the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment"> * (at your option) any later version.</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment"> * </span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment"> * Shark is distributed in the hope that it will be useful,</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment"> * GNU Lesser General Public License for more details.</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"> * </span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> * along with Shark.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> *</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> */</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment">//===========================================================================</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="preprocessor">#ifndef SHARK_ALGORITHMS_GRADIENTDESCENT_LINESEARCH_H</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="preprocessor">#define SHARK_ALGORITHMS_GRADIENTDESCENT_LINESEARCH_H</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="preprocessor">#include &lt;<a class="code" href="_base_8h.html">shark/LinAlg/Base.h</a>&gt;</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="preprocessor">#include &lt;<a class="code" href="_i_serializable_8h.html">shark/Core/ISerializable.h</a>&gt;</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="preprocessor">#include &lt;<a class="code" href="_abstract_objective_function_8h.html" title="AbstractObjectiveFunction.">shark/ObjectiveFunctions/AbstractObjectiveFunction.h</a>&gt;</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceshark.html" title="AbstractMultiObjectiveOptimizer.">shark</a> {</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>    </div>
<div class="foldopen" id="foldopen00044" data-start="{" data-end="};">
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="namespaceshark.html#a794f90d30bf600493abe8c1fb5cdbcc1">   44</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="namespaceshark.html#a794f90d30bf600493abe8c1fb5cdbcc1">LineSearchType</a> {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>    <a class="code hl_enumvalue" href="namespaceshark.html#a794f90d30bf600493abe8c1fb5cdbcc1a75f3b46c5979224eb3bf69483a46cf36">Dlinmin</a>,</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>    <a class="code hl_enumvalue" href="namespaceshark.html#a794f90d30bf600493abe8c1fb5cdbcc1ab943dc929227b99821f9f50f291b1f8b">WolfeCubic</a>,</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>    <a class="code hl_enumvalue" href="namespaceshark.html#a794f90d30bf600493abe8c1fb5cdbcc1a950dd44fffc182c8311a24c06d7210fc">Backtracking</a></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>};</div>
</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>    <span class="comment"></span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment">///\brief Wrapper for the linesearch class of functions in the linear algebra library.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment">///</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment">///This class is a wrapper for the linesearch class of functions of the linear algebra library.</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment">///The class is used for example in CG or BFGS for their internal linesearch learning steps.</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment">///It is NOT an Optimizer on its own, since it needs the Newton direction to be specified.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment">/// \ingroup gradientopt</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"></span><span class="keyword">template</span>&lt;<span class="keyword">class</span> SearchPo<span class="keywordtype">int</span>Type&gt;</div>
<div class="foldopen" id="foldopen00057" data-start="{" data-end="};">
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html">   57</a></span><span class="keyword">class </span><a class="code hl_class" href="classshark_1_1_line_search.html" title="Wrapper for the linesearch class of functions in the linear algebra library.">LineSearch</a>:<span class="keyword">public</span> <a class="code hl_class" href="classshark_1_1_i_serializable.html" title="Abstracts serializing functionality.">ISerializable</a> {</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>    </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#a3d0c55b5eda8c18a55b1501a90f065cf">   60</a></span>    <span class="keyword">typedef</span> <a class="code hl_class" href="classshark_1_1_abstract_objective_function.html" title="Super class of all objective functions for optimization and learning.">AbstractObjectiveFunction&lt;SearchPointType,double&gt;</a> <a class="code hl_typedef" href="classshark_1_1_line_search.html#a3d0c55b5eda8c18a55b1501a90f065cf">ObjectiveFunction</a>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"></span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment">    ///Initializes the internal variables of the class to useful default values.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment">    ///Dlinmin is used as default</span></div>
<div class="foldopen" id="foldopen00064" data-start="{" data-end="}">
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#ab909daa31662c63dbfc3a06c59c663fd">   64</a></span><span class="comment"></span>    <a class="code hl_function" href="classshark_1_1_line_search.html#ab909daa31662c63dbfc3a06c59c663fd">LineSearch</a>() {</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>        <a class="code hl_variable" href="classshark_1_1_line_search.html#ab05a9756db4f4b60d3f8b4ebbad9c6a0" title="initial [min,max] bracket for linesearch">m_minInterval</a>=0;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>        <a class="code hl_variable" href="classshark_1_1_line_search.html#a9cf4541ac22048de56dfb797b2e94cec" title="initial [min,max] bracket for linesearch">m_maxInterval</a>=1;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>        <a class="code hl_variable" href="classshark_1_1_line_search.html#a8c7f2e10fb43999dc6a9355ce2220bfa">m_lineSearchType</a>= <a class="code hl_enumvalue" href="namespaceshark.html#a794f90d30bf600493abe8c1fb5cdbcc1ab943dc929227b99821f9f50f291b1f8b">LineSearchType::WolfeCubic</a>;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>    }</div>
</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span> </div>
<div class="foldopen" id="foldopen00070" data-start="{" data-end="}">
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#aa6a5189c633cdb9afa68766fbf0e450e">   70</a></span>    <a class="code hl_enumeration" href="namespaceshark.html#a794f90d30bf600493abe8c1fb5cdbcc1">LineSearchType</a> <a class="code hl_function" href="classshark_1_1_line_search.html#aa6a5189c633cdb9afa68766fbf0e450e">lineSearchType</a>()<span class="keyword">const </span>{</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>        <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_line_search.html#a8c7f2e10fb43999dc6a9355ce2220bfa">m_lineSearchType</a>;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>    }</div>
</div>
<div class="foldopen" id="foldopen00073" data-start="{" data-end="}">
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#a685f8640b776aa2aa8a0089318de9e10">   73</a></span>    <a class="code hl_enumeration" href="namespaceshark.html#a794f90d30bf600493abe8c1fb5cdbcc1">LineSearchType</a> &amp;<a class="code hl_function" href="classshark_1_1_line_search.html#a685f8640b776aa2aa8a0089318de9e10">lineSearchType</a>() {</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>        <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_line_search.html#a8c7f2e10fb43999dc6a9355ce2220bfa">m_lineSearchType</a>;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>    }<span class="comment"></span></div>
</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">    ///minInterval sets the minimum initial bracket</span></div>
<div class="foldopen" id="foldopen00077" data-start="{" data-end="}">
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#a217ebe008c4c33da50caca40e9d6c1f0">   77</a></span><span class="comment"></span>    <span class="keywordtype">double</span> <a class="code hl_function" href="classshark_1_1_line_search.html#a217ebe008c4c33da50caca40e9d6c1f0" title="minInterval sets the minimum initial bracket">minInterval</a>()<span class="keyword">const </span>{</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>        <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_line_search.html#ab05a9756db4f4b60d3f8b4ebbad9c6a0" title="initial [min,max] bracket for linesearch">m_minInterval</a>;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>    }<span class="comment"></span></div>
</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">    ///minInterval sets the minimum initial bracket</span></div>
<div class="foldopen" id="foldopen00081" data-start="{" data-end="}">
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#a66da1b95f29121e24093a2b2c79d5a1c">   81</a></span><span class="comment"></span>    <span class="keywordtype">double</span> &amp;<a class="code hl_function" href="classshark_1_1_line_search.html#a66da1b95f29121e24093a2b2c79d5a1c" title="minInterval sets the minimum initial bracket">minInterval</a>() {</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span>        <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_line_search.html#ab05a9756db4f4b60d3f8b4ebbad9c6a0" title="initial [min,max] bracket for linesearch">m_minInterval</a>;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span>    }<span class="comment"></span></div>
</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">    ///maxInterval sets the maximum initial bracket</span></div>
<div class="foldopen" id="foldopen00085" data-start="{" data-end="}">
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#acb37384b4218a4e7893c04a7dd8a0594">   85</a></span><span class="comment"></span>    <span class="keywordtype">double</span> <a class="code hl_function" href="classshark_1_1_line_search.html#acb37384b4218a4e7893c04a7dd8a0594" title="maxInterval sets the maximum initial bracket">maxInterval</a>()<span class="keyword">const </span>{</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>        <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_line_search.html#a9cf4541ac22048de56dfb797b2e94cec" title="initial [min,max] bracket for linesearch">m_maxInterval</a>;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span>    }<span class="comment"></span></div>
</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">    ///maxInterval sets the maximum initial bracket</span></div>
<div class="foldopen" id="foldopen00089" data-start="{" data-end="}">
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#aec10878cb3b60e816f3cb9fcbf445a80">   89</a></span><span class="comment"></span>    <span class="keywordtype">double</span> &amp;<a class="code hl_function" href="classshark_1_1_line_search.html#aec10878cb3b60e816f3cb9fcbf445a80" title="maxInterval sets the maximum initial bracket">maxInterval</a>() {</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>        <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_line_search.html#a9cf4541ac22048de56dfb797b2e94cec" title="initial [min,max] bracket for linesearch">m_maxInterval</a>;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>    }</div>
</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"></span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">    ///initializes the internal state of the LineSearch class and sets the function on which the lineSearch is to be evaluated</span></div>
<div class="foldopen" id="foldopen00094" data-start="{" data-end="}">
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#ab9c07455e28cb27e697909daba8005d5">   94</a></span><span class="comment"></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classshark_1_1_line_search.html#ab9c07455e28cb27e697909daba8005d5" title="initializes the internal state of the LineSearch class and sets the function on which the lineSearch ...">init</a>(<a class="code hl_class" href="classshark_1_1_abstract_objective_function.html">ObjectiveFunction</a> <span class="keyword">const</span>&amp; objectiveFunction) {</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>        <a class="code hl_variable" href="classshark_1_1_line_search.html#a163fd204951c455d94e7a554df98a4d7" title="function to optimize">m_function</a> = &amp;objectiveFunction;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>    }</div>
</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"></span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">    ///performs a linesearch on the objectiveFunction given the starting point, its value the newton direction and optionally the derivative at the starting point</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment">    ///@param searchPoint the point where the linesearch start</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment">    ///@param pointValue the value of the function at searchPoint</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">    ///@param newtonDirection the search direction of the line search</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">    ///@param derivative the derivative of the function at searchPoint</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment">    ///@param stepLength initial step length guess for guiding the line search</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#add7cf71eb433f98c0af432aaf8f7717a">  104</a></span><span class="comment"></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classshark_1_1_line_search.html#add7cf71eb433f98c0af432aaf8f7717a">operator()</a>(SearchPointType &amp;<a class="code hl_function" href="namespaceshark.html#a68954303294e98c77d03dad52e32bd9e">searchPoint</a>,<span class="keywordtype">double</span> &amp;pointValue,SearchPointType <span class="keyword">const</span>&amp; newtonDirection, SearchPointType &amp;derivative, <span class="keywordtype">double</span> stepLength = 1.0)<span class="keyword">const</span>;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>    <span class="comment">//ISerializable</span></div>
<div class="foldopen" id="foldopen00107" data-start="{" data-end="}">
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#aaff584e0cb9bb7fd7eddb6f7420042b8">  107</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classshark_1_1_line_search.html#aaff584e0cb9bb7fd7eddb6f7420042b8" title="Read the component from the supplied archive.">read</a>(<a class="code hl_typedef" href="namespaceshark.html#ada68729491840669e47c8ad42282424f" title="Type of an archive to read from.">InArchive</a> &amp;archive) {</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>        archive&gt;&gt;<a class="code hl_variable" href="classshark_1_1_line_search.html#ab05a9756db4f4b60d3f8b4ebbad9c6a0" title="initial [min,max] bracket for linesearch">m_minInterval</a>;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>        archive&gt;&gt;<a class="code hl_variable" href="classshark_1_1_line_search.html#a9cf4541ac22048de56dfb797b2e94cec" title="initial [min,max] bracket for linesearch">m_maxInterval</a>;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>        archive&gt;&gt;<a class="code hl_variable" href="classshark_1_1_line_search.html#a8c7f2e10fb43999dc6a9355ce2220bfa">m_lineSearchType</a>;</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span>    }</div>
</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span> </div>
<div class="foldopen" id="foldopen00113" data-start="{" data-end="}">
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#a6921816c3674b7ca83f308df70932da3">  113</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classshark_1_1_line_search.html#a6921816c3674b7ca83f308df70932da3" title="Write the component to the supplied archive.">write</a>(<a class="code hl_typedef" href="namespaceshark.html#af4f8eb8e9618f5236b71bbcb12b8a524" title="Type of an archive to write to.">OutArchive</a> &amp;archive)<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span>        archive&lt;&lt;<a class="code hl_variable" href="classshark_1_1_line_search.html#ab05a9756db4f4b60d3f8b4ebbad9c6a0" title="initial [min,max] bracket for linesearch">m_minInterval</a>;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>        archive&lt;&lt;<a class="code hl_variable" href="classshark_1_1_line_search.html#a9cf4541ac22048de56dfb797b2e94cec" title="initial [min,max] bracket for linesearch">m_maxInterval</a>;</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>        archive&lt;&lt;<a class="code hl_variable" href="classshark_1_1_line_search.html#a8c7f2e10fb43999dc6a9355ce2220bfa">m_lineSearchType</a>;</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>    }</div>
</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span> </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="keyword">protected</span>:<span class="comment"></span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">    ///initial [min,max] bracket for linesearch</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#ab05a9756db4f4b60d3f8b4ebbad9c6a0">  122</a></span><span class="comment"></span>    <span class="keywordtype">double</span> <a class="code hl_variable" href="classshark_1_1_line_search.html#ab05a9756db4f4b60d3f8b4ebbad9c6a0" title="initial [min,max] bracket for linesearch">m_minInterval</a>;<span class="comment"></span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">    ///initial [min,max] bracket for linesearch</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#a9cf4541ac22048de56dfb797b2e94cec">  124</a></span><span class="comment"></span>    <span class="keywordtype">double</span> <a class="code hl_variable" href="classshark_1_1_line_search.html#a9cf4541ac22048de56dfb797b2e94cec" title="initial [min,max] bracket for linesearch">m_maxInterval</a>;</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#a8c7f2e10fb43999dc6a9355ce2220bfa">  126</a></span>    <a class="code hl_enumeration" href="namespaceshark.html#a794f90d30bf600493abe8c1fb5cdbcc1">LineSearchType</a> <a class="code hl_variable" href="classshark_1_1_line_search.html#a8c7f2e10fb43999dc6a9355ce2220bfa">m_lineSearchType</a>;</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"></span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">    ///function to optimize</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="classshark_1_1_line_search.html#a163fd204951c455d94e7a554df98a4d7">  129</a></span><span class="comment"></span>    <a class="code hl_class" href="classshark_1_1_abstract_objective_function.html">ObjectiveFunction</a> <span class="keyword">const</span>* <a class="code hl_variable" href="classshark_1_1_line_search.html#a163fd204951c455d94e7a554df98a4d7" title="function to optimize">m_function</a>;</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>};</div>
</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="keyword">extern</span> <span class="keyword">template</span> <span class="keyword">class </span><a class="code hl_class" href="classshark_1_1_line_search.html" title="Wrapper for the linesearch class of functions in the linear algebra library.">LineSearch&lt;RealVector&gt;</a>;</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="keyword">extern</span> <span class="keyword">template</span> <span class="keyword">class </span><a class="code hl_class" href="classshark_1_1_line_search.html" title="Wrapper for the linesearch class of functions in the linear algebra library.">LineSearch&lt;FloatVector&gt;</a>;</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="preprocessor">#ifdef SHARK_USE_OPENCL</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="keyword">extern</span> <span class="keyword">template</span> <span class="keyword">class </span><a class="code hl_class" href="classshark_1_1_line_search.html" title="Wrapper for the linesearch class of functions in the linear algebra library.">LineSearch&lt;RealGPUVector&gt;</a>;</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="keyword">extern</span> <span class="keyword">template</span> <span class="keyword">class </span><a class="code hl_class" href="classshark_1_1_line_search.html" title="Wrapper for the linesearch class of functions in the linear algebra library.">LineSearch&lt;FloatGPUVector&gt;</a>;</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>}</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span> </div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div>
</body>
</html>
